<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>text_routines: common_schema documentation</title>
	<meta name="description" content="text_routines: common_schema" />
	<meta name="keywords" content="text_routines: common_schema" />
	<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>common_schema</h1> <strong>2.2</strong> documentation
			<div class="subtitle">DBA's framework for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="text_routines.html">text_routines</a></h2>	
<h3>SYNOPSIS</h3>

<p>
Text routines: string operations
<ul>
	<li><a href="decode_xml.html">decode_xml()</a>: Decode XML characters in text.</li>
	<li><a href="encode_xml.html">encode_xml()</a>: Encode a given text for XML.</li>
	<li><a href="extract_json_value.html">extract_json_value()</a>: Extract value from JSON notation via XPath.</li>
	<li><a href="get_num_tokens.html">get_num_tokens()</a>: Return number of tokens in delimited text.</li>
	<li><a href="get_option.html">get_option()</a>: Extract value from options dictionary based on key.</li>
	<li><a href="hexcode_text.html">hexcode_text()</a>: Present a Hexadecimal table for given text's characters.</li>
	<li><a href="json_to_xml.html">json_to_xml()</a>: Convert valid JSON to equivalent XML.</li>	
	<li><a href="like_to_rlike.html">like_to_rlike()</a>: Convert a LIKE expression to an RLIKE (REGEXP) expression.</li>
	<li><a href="mysql_qualify.html">mysql_qualify()</a>: Return a qualified MySQL object name.</li>
	<li><a href="prettify_message.html">prettify_message()</a>: Outputs a prettified text message, one row per line in text</li>
	<li><a href="replace_all.html">replace_all()</a>: Replaces characters in a given text with a given replace-text.</li>
	<li><a href="replace_sections.html">replace_sections()</a>: Search and replace text appearing between section start/end.</li>
	<li><a href="split_token.html">split_token()</a>: Return substring by index in delimited text.</li>
	<li><a href="starts_with.html">starts_with()</a>: Checks whether given text starts with given prefix.</li>
	<li><a href="strip_urls.html">strip_urls()</a>: Strips URLs from given text, replacing them with an empty string.</li>
	<li><a href="tokenize.html">tokenize()</a>: Outputs ordered result set of tokens of given text.</li>
	<li><a href="trim_wspace.html">trim_wspace()</a>: Trim white space characters on both sides of text.</li>
</ul>
</p>

<h3>EXAMPLES</h3>
	<p>
		Calculate 64 bit CRC for some text:
	</p>
	<blockquote><pre>mysql&gt; SELECT common_schema.crc64('mysql') AS crc64;
+---------------------+
| crc64               |
+---------------------+
| 9350511318824990686 |
+---------------------+
</pre></blockquote>

	<p>
		Use <i>shorttime_to_seconds()</i> to parse '2h', making for 2 hours:
	</p>
	<blockquote><pre>mysql&gt; SELECT shorttime_to_seconds('2h') as seconds;
+---------+
| seconds |
+---------+
|    7200 |
+---------+
</pre></blockquote>

	<p>
		Extract value from dictionary:
	</p>
	<blockquote><pre>mysql&gt; SELECT get_option('{width: 100, height: 180, color: #ffa030}', 'height') AS result;
+--------+
| result |
+--------+
| 180    |
+--------+
</pre></blockquote>
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="search">
					Search online documentation
					<form id="search_form" name="search_form" method="GET" 
						action="http://www.google.com/search" 
						onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
						<input type="text" name="search_term" value=""/>
						<input type="hidden" name="q" value=""/>
						<input type="submit" value="go"/>						
					</form>
				</div>
				<div id="menu">
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Documentation" href="documentation.html">Documentation</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="Risks" href="risks.html">Risks</a></li>
					</ul>						
					<h3>QUERY SCRIPT</h3>
					<ul>
						<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
						<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
						<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
						<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
						<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
						<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
					</ul>						
					<h3>DEBUG</h3>
					<ul>
						<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
						<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
						<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
					</ul>						
					<h3>ROUTINES</h3>
					<ul>
						<li><a title="Execution &amp; flow control" href="execution_routines.html">Execution & flow control</a></li>
						<li><a title="General" href="general_routines.html">General</a></li>
						<li><a title="Process" href="process_routines.html">Process</a></li>
						<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
						<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
						<li><a title="Security" href="security_routines.html">Security</a></li>
						<li><a title="Text" href="text_routines.html">Text</a></li>
						<li><a title="Time &amp; date" href="temporal_routines.html">Time & date</a></li>
						<li><a title="Charting" href="charting_routines.html">Charting</a></li>
					</ul>
					<h3>VIEWS</h3>
					<ul>
						<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
						<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
						<li><a title="Process" href="process_views.html">Process</a></li>
						<li><a title="Security" href="security_views.html">Security</a></li>
						<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
						<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
						<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
						<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
					</ul>						
					<h3>DATA</h3>
					<ul>
						<li><a title="tables" href="tables.html">Tables</a></li>
						<li><a title="variables" href="variables.html">Variables</a></li>
					</ul>						
					<h3>META</h3>
					<ul>
						<li><a title="Help" href="help.html">help</a></li>
						<li><a title="Metadata" href="metadata.html">metadata</a></li>
						<li><a title="status" href="status.html">status</a></li>
					</ul>						
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">common_schema</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
